Skip to main content

Documentation Index

Fetch the complete documentation index at: https://superdoc-dependabot-npm_and_yarn-npm_and_yarn-e04d5d616f.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Base URL

All API requests should be made to:
https://api.superdoc.dev/v1

Authentication

All endpoints require authentication using Bearer tokens. Include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY

Get your API key

Sign up for a free account to get your API key

Available Endpoints

Our API provides the following endpoints:

Convert to PDF

Convert DOCX files to PDF format

Public Convert

Rate-limited public conversion endpoint

Health Check

Check API service health and status

API Info

Get API information and available endpoints

Request Format

Headers

HeaderRequiredDescription
AuthorizationYes*Bearer token with your API key
Content-TypeVariesmultipart/form-data for file uploads
*Not required for public endpoints

File Uploads

For endpoints that accept files, use multipart/form-data:
curl -X POST https://api.superdoc.dev/v1/convert?format=pdf \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@document.docx"

Response Format

Success Response

Successful file conversions return the converted file directly:
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="document.pdf"

[Binary PDF data]

Error Response

Errors return JSON with consistent structure:
{
  "code": "ERROR_CODE",
  "error": "Error Type",
  "message": "Human-readable error message",
  "requestId": "req_abc123"
}

Rate Limiting

API requests are rate-limited based on your plan:
PlanRequests/HourRequests/Day
Free1001,000
Pro1,00010,000
EnterpriseUnlimitedUnlimited
Rate limit headers are included in responses:
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1673612400

File Size Limits

  • Authenticated endpoints: 25MB maximum
  • Public endpoints: 5MB maximum
Need to convert larger files? Contact us at api@superdoc.dev for enterprise options.

SDK Support

Official SDKs are available for:

JavaScript/Node.js

npm install @superdoc/api

Python

pip install superdoc

More coming soon

PHP, Ruby, Go, and more